home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / utils / file / managers / mc-3.2 / mc-3 / mc-3.2.1 / INSTALL < prev    next >
Encoding:
Text File  |  1996-05-17  |  19.4 KB  |  496 lines
  1. -*-text-*-
  2.  
  3. This file contains:
  4.  
  5. - Installation instructions and notes for the Midnight Commander
  6. - Where to get more information on the Midnight Commander
  7. - Common problems
  8. - Information on porting the program
  9. - Obtaining the missing pieces of the Midnight Commander
  10.  
  11.  
  12. Installation instructions for the Midnight Commander
  13. ----------------------------------------------------
  14.  
  15.    The `configure' shell script attempts to guess correct values for
  16. various system-dependent variables used during compilation, and creates
  17. the Makefile.  It also creates a file `config.status' that you can run
  18. in the future to recreate the current configuration.
  19.  
  20. To compile this package:
  21.  
  22. 1.  Configure the package for your system.
  23.  
  24.    Normally, you just `cd' to the directory containing the package's
  25. source code and type `./configure'.  If you're using `csh' on an old
  26. version of System V, you might need to type `sh configure' instead to
  27. prevent `csh' from trying to execute `configure' itself (under AIX,
  28. you may need to use ksh instead of sh).
  29.  
  30.    Running `configure' takes a while.  While it is running, it
  31. prints some messages that tell what it is doing.  If you don't want to
  32. see any messages, run `configure' with its standard output redirected
  33. to `/dev/null'; for example, `./configure >/dev/null'.
  34.  
  35.    To compile the package in a different directory from the one
  36. containing the source code, you must use a version of `make' that
  37. supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  38. directory where you want the object files and executables to go and run
  39. the `configure' script.  `configure' automatically checks for the
  40. source code in the directory that `configure' is in and in `..'.  If
  41. for some reason `configure' is not in the source code directory that
  42. you are configuring, then it will report that it can't find the source
  43. code.  In that case, run `configure' with the option `--srcdir=DIR',
  44. where DIR is the directory that contains the source code.
  45.  
  46.    By default, `make install' will install the package's files in
  47. `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  48. installation prefix other than `/usr/local' by giving `configure' the
  49. option `--prefix=PATH'.  Alternately, you can do so by consistently
  50. giving a value for the `prefix' variable when you run `make', e.g.,
  51.      make prefix=/usr/gnu
  52.      make prefix=/usr/gnu install
  53.  
  54.    You can specify separate installation prefixes for
  55. architecture-specific files and architecture-independent files.  If
  56. you give `configure' the option `--exec-prefix=PATH' or set the `make'
  57. variable `exec_prefix' to PATH, the package will use PATH as the
  58. prefix for installing programs and libraries.  Data files and
  59. documentation will still use the regular prefix.  Normally, all files
  60. are installed using the same prefix.
  61.  
  62.     The program detects if you have the gpm library installed.  If you
  63. installed the gpm mouse library in a non-standard place, you will need
  64. to use the --with-gpm-mouse flag with the directory base where you
  65. installed the gpm package.
  66.  
  67.    `configure' also recognizes the following options:
  68.  
  69. `--help'
  70.      Print a summary of the options to `configure', and exit.
  71.  
  72. `--quiet'
  73. `--silent'
  74.      Do not print messages saying which checks are being made.
  75.  
  76. `--verbose'
  77.      Print the results of the checks.
  78.  
  79. `--version'
  80.      Print the version of Autoconf used to generate the `configure'
  81.      script, and exit.
  82.  
  83. `--with-gpm-mouse=PATH'
  84.      Use this flag if your GPM mouse package is not installed in
  85.      a standard place.  The configure will append `lib' and
  86.      `include' to find the libgpm.a and gpm.h files respectively.
  87.  
  88. `--with-mmap'
  89.      Needed when compiling under AIX if you want the fast viewer.
  90.  
  91. `--with-subshell[=optional]', `--without-subshell' 
  92.      The subshell support is by default turned on, you can disable
  93.      this by using the --without-subshell option.  If you pass the
  94.      =optional parameter, then the subshell support is turned off by
  95.      default, to turn it on, you have to specify the `-U' flag when
  96.      running the program.
  97.  
  98. `--with-termnet'
  99.      Enables the network support with the Term package.
  100.  
  101. `--without-vfs'
  102.      This option disables the Virtual File System switch code in the
  103.      Midnight Commander and uses the standard file system calls for
  104.      file access.  If you specify this option you will not get the
  105.      transparent tar File system manipulation as well nor the
  106.      networked Midnight Commander file system.
  107.  
  108. `--with-xview'                 [WARNING: X code is not released]
  109.      This option enables including the XView version.
  110.  
  111. `--with-xview-includes=DIR'    [WARNING: X code is not released]
  112.      Lets you specify the place where you have your xview headers installed.
  113.      It should be the directory, which has subdirectories xview and
  114.      hopefuly xview_private.
  115.  
  116. `--with-xview-libraries=DIR'   [WARNING: X code is not released]
  117.      Lets you specify the place where you have your xview libraries - 
  118.      libolgx and libxview.
  119.  
  120. `--with-xv-bindir=DIR'         [WARNING: X code is not released]
  121.      Lets you specify the place where program mxc will be installed.
  122.      Default is somewhere in your XView binaries directory,
  123.      $OPENWINHOME/bin.
  124.  
  125. `--with-tk'                    [WARNING: X code is not released]
  126.      This option enables including the Tcl/Tk version.
  127.  
  128. `--with-tk-includes=DIR'       [WARNING: X code is not released]
  129.      Lets you specify the place where you have your Tcl/Tk headers installed.
  130.      It should be a directory containing tcl.h and tk.h.
  131.  
  132. `--with-tk-libraries=DIR'      [WARNING: X code is not released]
  133.      Lets you specify the place where you have your Tcl/Tk libraries - 
  134.      libtcl and libtk.
  135.  
  136. `--without-dusum'
  137.      This option disables a feature of the Midnight Commander, which is
  138.      forking the du command with the -s option when you want to calculate
  139.      directory sizes.
  140.  
  141. `--with-sco'
  142.      This option is used to compile on SCO: it disables the terminal
  143.      resizing mechanism and uses the BSD-like pseudoterminal handling.
  144.  
  145. You may also tell configure which display manager you want to use with
  146. the Midnight Commander.  The configure script will use SLang as default,
  147. but you can override this by using any of the following flags (please 
  148. note that slang is included as part of the distribution),
  149.  
  150. `--with-slang' (default)
  151.      This is used to configure the program to use the SLang screen
  152.      manager.  This is included as part of the Midnight Commander,
  153.      you don't need it installed on your system.
  154.      Slang is the only library that will let you resize the Midnight
  155.      Commander window on an xterm.
  156.  
  157.      This option will usually try to use the terminfo database if it
  158.      is available, otherwise it will use the termcap database.  At
  159.      compile time, you may force the use the terminal database with
  160.      the `--with-termcap' and `--with-terminfo' options.
  161.  
  162. `--with-ncurses[=directory]'
  163.      Use this flag (either with or without the =directory part), if
  164.      you want to compile with ncurses instead of the default SLang.
  165.  
  166.      Use the =directory part if your ncurses is not installed in any of the
  167.      places configure will check (/usr/include, /usr/include/ncurses,
  168.      /usr/local/include and /usr/local/include/ncurses).
  169.      The argument to this flag is the base directory where the ncurses
  170.      files are located.  The configure will append lib and include to
  171.      find the libncurses.a and ncurses.h file respectively.  For
  172.      example, if you have installed ncurses under /gnu/lib and
  173.      /gnu/include, you specify: --with-ncurses=/gnu
  174.  
  175.      You will need the ncurses package only if your system does not
  176.      provide a compatible curses.  If after compiling, the program
  177.      says that it can't resolve the has_colors function, then you need
  178.      the ncurses package or you may always go back to the included SLang
  179.      screen manager.
  180.  
  181. `--with-vcurses[=directory]'
  182.      Use this flag to force the Midnight Commander to use a SystemV
  183.      type ncurses, the optional directory specifies where should
  184.      the C compiler find the include files.
  185.  
  186. `--with-sunos-curses'
  187.      You use this flag on SunOS machines if you want to use SunOS 4.x
  188.      curses instead of ncurses.  You don't need this flag if you don't
  189.      have ncurses installed: it's only needed to force the usage of
  190.      SunOS curses over ncurses.
  191.  
  192.    `configure' also accepts and ignores some other options.
  193.  
  194.    On systems that require unusual options for compilation or linking
  195. that the package's `configure' script does not know about, you can give
  196. `configure' initial values for variables by setting them in the
  197. environment.  In Bourne-compatible shells, you can do that on the
  198. command line like this:
  199.  
  200.      CC='gcc -traditional' LIBS=-lposix ./configure
  201.  
  202. On systems that have the `env' program, you can do it like this:
  203.  
  204.      env CC='gcc -traditional' LIBS=-lposix ./configure
  205.  
  206.    Here are the `make' variables that you might want to override with
  207. environment variables when running `configure'.
  208.  
  209.    For these variables, any value given in the environment overrides the
  210. value that `configure' would choose:
  211.  
  212.  - Variable: CC
  213.      C compiler program.  The default is `cc'.
  214.  
  215.  - Variable: CFLAGS
  216.      The default flags used to build the program.
  217.  
  218.  - Variable: INSTALL
  219.      Program to use to install files.  The default is `install' if you
  220.      have it, `cp' otherwise.
  221.  
  222.    For these variables, any value given in the environment is added to
  223. the value that `configure' chooses:
  224.  
  225.  - Variable: LIBS
  226.      Libraries to link with, in the form `-lfoo -lbar...'.
  227.  
  228.    If you need to do unusual things to compile the package, we encourage
  229. you to figure out how `configure' could check whether to do them, and
  230. mail diffs or instructions to the address given in the README so we
  231. can include them in the next release.
  232.  
  233. 2.  Type `make' to compile the package.
  234.  
  235. 3.  If the package comes with self-tests and you want to run them,
  236. type `make check'.  If you're not sure whether there are any, try it;
  237. if `make' responds with something like
  238.     make: *** No way to make target `check'.  Stop.
  239. then the package does not come with self-tests.
  240.  
  241. 4.  Type `make install' to install programs, data files, and
  242. documentation.
  243. If your system is Linux, then install installs the Linux console screen
  244. saver as well.
  245.  
  246. 5.  You can remove the program binaries and object files from the
  247. source directory by typing `make clean'.  To also remove the
  248. Makefile(s), the header file containing system-dependent definitions
  249. (if the package uses one), and `config.status' (all the files that
  250. `configure' created), type `make realclean'. If you want to clean the source
  251. tree completely, so that it contains only those files that should be
  252. packaged in the archive, issue `make distclean'. If you've run configure in
  253. a different directory than the source tree, distclean won't remove your *.o
  254. and linked programs in that directory.
  255.  
  256. 6.  The Midnight Commander allows you to be kept on the directory you
  257. were when you quit the program, this is done with a shell function,
  258. the man page has more information about this.  If you want to let the
  259. install program make the change to your /etc/profile or your
  260. ~/.profile or ~/.bashrc, then type: `make mcfninstall'.
  261.  
  262.    The file `configure.in' is used to create `configure' by a program
  263. called `autoconf'.  You only need it if you want to regenerate
  264. `configure' using a newer version of `autoconf'.
  265.  
  266.  
  267. - Where to get more information on the Midnight Commander
  268. ---------------------------------------------------------
  269.  
  270. Janne Kukonlehto set up a WWW page, here is the URL:
  271. http://stekt.oulu.fi/~jtklehto/mc/
  272.  
  273. We also a set of mailing lists for the program:
  274.  
  275. mc-announce: Announcements of new version of the Midnight Commander.
  276. mc-digest:   Digest version of the mc list.
  277. mc-patches:  Patches by mail (also on the ftp site).
  278. mc:          Discussion on the Midnight Commander file manager.
  279. mc-devel:    For discussion between the developers of the program.
  280.  
  281. to subscribe to the mailing lists, send a message to:
  282.  
  283. majordomo@roxanne.nuclecu.unam.mx
  284.  
  285. with the following text in the body of the message:
  286.  
  287. subscribe <list-name> [address]
  288.  
  289. The address is optional and list-name is one of the above list names
  290. (mc, mc-announce, mc-patches or mc-digest).
  291.  
  292.  
  293. Notes about the Midnight Commander installation
  294. ------------------------------------------------
  295.  
  296. The Midnight Commander has been run in the following configurations:
  297.  
  298. i386-linux-linux1.0
  299. i386-linux-linux1.1
  300. i386-linux-linux1.2
  301. i386-linux-linux1.3
  302. mips-dec-ultrix4.3
  303. mips-dec-netbsd1.0
  304. mips-sgi-irix5.2
  305. mips-sgi-irix5.3
  306. rs6000-ibm-aix3.2.5
  307. sparc-sun-sunos4.1
  308. sparc-sun-netbsd1.0
  309. sparc-sun-solaris2.3
  310. hppa-hp-hpux9
  311. hppa-hp-hpux7
  312. m68k-apple-aux
  313. mc88110-aviion-dgux5.4
  314.  
  315.  
  316. Since the Midnight Commander is configured via the GNU autoconf
  317. program, it's not difficult to run it in other operating systems.
  318.  
  319. If you're using AIX, with the cc6000 compiler, you have to specify the
  320. `--with-mmap' command line option. 
  321.  
  322. You will need GNU C (or an ANSI C Compiler) and optionally a color
  323. curses library (ncurses is a good choice).  The Midnight Commander now
  324. comes with the Slang screen manager, a fast screen manager, so ncurses
  325. is not required anymore unless you want to use it.  
  326.  
  327. Many Linux systems ship with ncurses version 1.8.0 or 1.8.1; the
  328. Midnight Commander may run with it, but some bugs in this version of
  329. NCurses sometimes make the display look strange (which is not the
  330. intention).  
  331.  
  332. VERY IMPORTANT NCURSES NOTE: On some architectures, the default
  333. compilation mode for ncurses it to include the buggy OPT_MVCUR in the
  334. Makefile.  If that is the case, please remove it before compiling.
  335.  
  336. Since version 0.9 the Midnight Commander comes with mouse support on
  337. xterms and in the Linux console. In order to take advantage of the
  338. mouse support on the Linux console you will need the gpm mouse server
  339. (see the section "Obtaining the Missing Pieces" in this file).
  340.  
  341. Once you get the Mouse Server, compile it and install it, then you
  342. will have to specify the `--with-gpm-mouse' flag to the configure
  343. program if you installed it in a non-standard directory.  If you
  344. installed the gpm package under /usr or /usr/local, you don't need to
  345. specify this flag; configure will find gpm for you.  The support for
  346. mice on xterms is always compiled in.
  347.  
  348. We are working on further enhancements to the program, but we're not
  349. sure which ones must go first.  If you would like to point us in the
  350. Right Direction we will be glad to hear from you (you could check the
  351. file TODO included with this distribution for the current projects).
  352.  
  353. If you happen to find an undocumented feature that doesn't do what you
  354. expected, please drop us a note telling us as much as you can about
  355. the problem you're experiencing (to miguel@roxanne.nuclecu.unam.mx).
  356.  
  357.  
  358. Porting the program
  359. -------------------
  360.  
  361. Random notes on porting to other architectures.  
  362.  
  363. The program requires normally ncurses.  If you don't want to install
  364. ncurses and your OS is a SystemV Release 4 variant, maybe the curses
  365. supplied with your system will do the work.  If you experience display
  366. problems, then it means that we are dealing with a buggy
  367. implementation of curses.  You have two options: one, download ncurses
  368. and recompile with ncurses or recompile all your source code with the
  369. symbol BUGGY_CURSES defined.  
  370. But you can always switch to the default SLang screen manager.
  371.  
  372. The fast way to do this is to:
  373.  
  374. make clean; make XINC=-DBUGGY_CURSES
  375.  
  376. The correct thing is that you add a detection case to the file
  377. ncurses.h (provided with this program) and again, run: make clean;
  378. make;
  379.  
  380. If you add the detection case, please, send me a patch, so that I
  381. could include it in future versions of the program.
  382.  
  383.  
  384. Obtaining the missing pieces of the Midnight Commander
  385. ------------------------------------------------------
  386.  
  387. The Midnight Commander will build without requiring you to get any
  388. other software packages, however, you may be interested in enhancing
  389. the Midnight Commander environment with some of these:
  390.  
  391. o Terminal database
  392.  
  393.   There are many incomplete terminal databases out there, you can get
  394.   the official termcap and terminfo database from the following URL:
  395.  
  396.   http://www.ccil.org/~esr/ncurses.html
  397.  
  398.   Some terminfo data are included with the mc distribution (lib/*.ti).
  399.   Particularly linux, xterm and vt100. Use e.g. ''tic linux.ti'' to
  400.   use them.
  401.  
  402.   If you want to run mc on xterm/color_xterm/ansi_xterm (not rxvt), then
  403.   you might read lib/README.xterm for further information.
  404.  
  405. o In the past the Midnight Commander required the NCurses library to
  406.   build, now it's optional and it's not the recommended way of using
  407.   it, but in case you feel nostalgic, you can get the NCurses library 
  408.   from:
  409.  
  410.   ftp.nuclecu.unam.mx:/Midnight
  411.   ftp.netcom.com:/pub/zm/zmbenhal
  412.  
  413.   When compiling ncurses, please check that you don't define
  414.   OPT_MVCUR since it's buggy.
  415.  
  416. o The GPM Mouse Server is available at:
  417.  
  418.   iride.unipv.it:/pub/gpm
  419.  
  420. o The X Windows System libraries are only used if you are going to
  421.   build the X11 versions of the program.  Please note that this code
  422.   is not finished, so it's only useful if you want to look at what we
  423.   are doing or want to help in one of the two X11 versions.
  424.   
  425. o The XView library can be obtained from (currently the newest is
  426.   XView3.2p1-X11R6.tar.gz):
  427.  
  428.   ftp.nuclecu.unam.mx:/Midnight/devel/XView.libs
  429.   ftp.x.org:/contrib/libraries
  430.   ftp.cvut.cz:/pub/x11/contrib/libraries
  431.  
  432.   - Linux/ELF shared binaries:
  433.  
  434.       sunsite.unc.edu:/pub/Linux/libs/X/xview
  435.       ftp.cvut.cz:/pub/linux/sunsite/libs/X/xview
  436.  
  437. o The Tcl/Tk libraries can be obtained from:
  438.  
  439.   ftp.smli.com:/pub/tcl
  440.   ftp.aud.alcatel.com:/tcl/ftp.smli.com
  441.   ftp.cvut.cz:/pub/tcl/ftp.smli.com
  442.  
  443.   - Linux/ELF shared binaries:
  444.  
  445.       ftp.ods.com:/pub/linux
  446.       ftp.cvut.cz:/pub/linux/ods
  447.  
  448. o The Xpm library (used by the XView version) can be obtained from
  449.   (currently xpm-3.4f.tar.gz):
  450.  
  451.   koala.inria.fr:/pub/xpm
  452.   ftp.x.org:/contrib/libraries
  453.   ftp.cvut.cz:/pub/x11/contrib/libraries
  454.  
  455.   - Linux/ELF shared binaries:
  456.  
  457.       ftp.ctd.comsat.com:/pub/linux/ELF
  458.       ftp.cvut.cz:/pub/linux/comsat
  459.  
  460. To get the mouse support working on the Linux console:
  461.  
  462. If you're using Linux version >= 1.1.34, then you will have to choose yes
  463. to selection when you compile your kernel. If your Linux version is
  464. older than this one, you may try to apply one of the patches included in
  465. the gpm package.
  466.  
  467. And the GNU C Compiler may be obtained from the following sites:
  468.  
  469.         ASIA: ftp.cs.titech.ac.jp, utsun.s.u-tokyo.ac.jp:/ftpsync/prep,
  470.               cair.kaist.ac.kr:/pub/gnu
  471.         AUSTRALIA: archie.au:/gnu (archie.oz or archie.oz.au for ACSnet)
  472.         AFRICA: ftp.sun.ac.za:/pub/gnu
  473.         MIDDLE-EAST: ftp.technion.ac.il:/pub/unsupported/gnu
  474.         EUROPE: ftp.cvut.cz:/pub/gnu, irisa.irisa.fr:/pub/gnu, 
  475.               ftp.univ-lyon1.fr:pub/gnu, ftp.mcc.ac.uk, 
  476.               unix.hensa.ac.uk:/pub/uunet/systems/gnu,
  477.               src.doc.ic.ac.uk:/gnu, ftp.win.tue.nl, ugle.unit.no, 
  478.               ftp.denet.dk, ftp.informatik.rwth-aachen.de:/pub/gnu, 
  479.               ftp.informatik.tu-muenchen.de, ftp.eunet.ch, 
  480.               nic.switch.ch:/mirror/gnu, nic.funet.fi:/pub/gnu, isy.liu.se, 
  481.               ftp.stacken.kth.se, ftp.luth.se:/pub/unix/gnu, archive.eu.net
  482.         CANADA: ftp.cs.ubc.ca:/mirror2/gnu
  483.         USA: wuarchive.wustl.edu:/mirrors/gnu, labrea.stanford.edu,
  484.              ftp.kpc.com:/pub/mirror/gnu, ftp.cs.widener.edu, uxc.cso.uiuc.edu,
  485.              col.hp.com:/mirrors/gnu, ftp.cs.columbia.edu:/archives/gnu/prep,
  486.              gatekeeper.dec.com:/pub/GNU, ftp.uu.net:/systems/gnu
  487.  
  488.  
  489. Unsupported options to configure:
  490. ---------------------------------
  491. `--with-bsd-curses'
  492.      If you don't want to use ncurses and are using an Ultrix box, you
  493.      can use this switch.  Be aware that ncurses is a better option
  494.      than the curses included in Ultrix.
  495.  
  496.